// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

package org.apache.doris.nereids.trees.expressions;

import org.apache.doris.nereids.exceptions.UnboundException;
import org.apache.doris.nereids.trees.expressions.shape.TernaryExpression;
import org.apache.doris.nereids.trees.expressions.visitor.ExpressionVisitor;
import org.apache.doris.nereids.types.BooleanType;
import org.apache.doris.nereids.types.DataType;

import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;

import java.util.List;

/**
 * Between predicate expression.
 */
public class Between extends Expression implements TernaryExpression {

    private final Expression compareExpr;
    private final Expression lowerBound;
    private final Expression upperBound;

    /**
     * Constructor of ComparisonPredicate.
     *
     * @param compareExpr    compare of expression
     * @param lowerBound     left child of between predicate
     * @param upperBound     right child of between predicate
     */
    public Between(Expression compareExpr, Expression lowerBound,
                   Expression upperBound) {
        this(ImmutableList.of(compareExpr, lowerBound, upperBound));
    }

    /**
     * Constructor of ComparisonPredicate.
     *
     * @param children 3 children: compareExpr, lowerBound, upperBound
     */
    public Between(List<Expression> children) {
        super(children);
        this.compareExpr = children.get(0);
        this.lowerBound = children.get(1);
        this.upperBound = children.get(2);
    }

    @Override
    public DataType getDataType() throws UnboundException {
        return BooleanType.INSTANCE;
    }

    @Override
    public String computeToSql() {
        return compareExpr.toSql() + " BETWEEN " + lowerBound.toSql() + " AND " + upperBound.toSql();
    }

    @Override
    public String toString() {
        return compareExpr + " BETWEEN " + lowerBound + " AND " + upperBound;
    }

    // nullable is true if any children is nullable,
    // but between is not PropagateNullable,
    // because FoldConstantRuleOnFE will fold a PropagateNullable expression to NULL if any children is NULL.
    // but `4 BETWEEN NULL AND 3` should fold to FALSE, not NULL.
    @Override
    public boolean nullable() {
        for (Expression child : children()) {
            if (child.nullable()) {
                return true;
            }
        }
        return false;
    }

    public <R, C> R accept(ExpressionVisitor<R, C> visitor, C context) {
        return visitor.visitBetween(this, context);
    }

    public Expression getCompareExpr() {
        return compareExpr;
    }

    public Expression getLowerBound() {
        return lowerBound;
    }

    public Expression getUpperBound() {
        return upperBound;
    }

    @Override
    public Between withChildren(List<Expression> children) {
        Preconditions.checkArgument(children.size() == 3);
        return new Between(children);
    }
}
